Implement timeout capability. Apply timeout to crypto response #278
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a generic timeout utility and wires client-side response timeouts into crypto operations, plus unit tests for the timeout helper.
Changes:
- Add a generic timeout module (
wh_timeout.[ch]) based onWH_GETTIME_US()and expose it via configuration (WOLFHSM_CFG_ENABLE_TIMEOUT) and a new error codeWH_ERROR_TIMEOUT. - Extend
whClientContext/whClientConfigand addwh_Client_RecvResponseTimeout, then route all crypto client receive paths through a new_recvCryptoResponsehelper that uses the timeout when enabled. - Add unit tests for the timeout helper and enable timeout support in the test configuration.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| wolfhsm/wh_timeout.h | Declares timeout context/config types and the timeout API used by the client; documentation establishes that timeoutUs == 0 disables the timeout. |
| wolfhsm/wh_settings.h | Documents WOLFHSM_CFG_ENABLE_TIMEOUT as enabling timeout helpers and client response timeouts; also defines WH_GETTIME_US(), which the timeout code relies on. |
| wolfhsm/wh_error.h | Introduces WH_ERROR_TIMEOUT to signal an expired timeout from client operations. |
| wolfhsm/wh_client.h | Adds a per-client respTimeout context, an optional respTimeout config, and declares wh_Client_RecvResponseTimeout behind WOLFHSM_CFG_ENABLE_TIMEOUT. |
| test/wh_test_timeout.h | Declares the whTest_Timeout unit test entry point. |
| test/wh_test_timeout.c | Implements unit tests for wh_Timeout_*, including callback invocation, stop/disable behavior, and bad-argument handling. |
| test/wh_test.c | Wires whTest_Timeout() into the unit test suite when WOLFHSM_CFG_ENABLE_TIMEOUT is defined. |
| test/config/wolfhsm_cfg.h | Enables WOLFHSM_CFG_ENABLE_TIMEOUT in the test configuration and ensures a valid time source via WOLFHSM_CFG_PORT_GETTIME. |
| src/wh_timeout.c | Implements the timeout helper functions; currently treats timeoutUs == 0 as an error in wh_Timeout_Start, which conflicts with the documented “0 disables” semantics and impacts higher-level usage. |
| src/wh_client_crypto.c | Introduces _recvCryptoResponse and switches all crypto receive loops to use it; with timeout support enabled this always goes through wh_Client_RecvResponseTimeout and the per-client respTimeout. |
| src/wh_client.c | Initializes the optional respTimeout context in wh_Client_Init and adds wh_Client_RecvResponseTimeout, which loops on WH_ERROR_NOTREADY until a valid response arrives or the timeout expires. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AlexLanzano
force-pushed
the
timeout
branch
2 times, most recently
from
5498633 to
f7a30b3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AlexLanzano
added a commit
to AlexLanzano/wolfHSM
that referenced
this pull request
Jan 30, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #130